/*
 * MIT License
 *
 * Copyright (c) 2020 wen.gu <454727014@qq.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/***************************************************************************
 * Name: dog_shared_library.h
 *
 * Purpose: shared library load wrapper for puppy dog
 *
 * Developer:
 *   wen.gu , 2020-08-19
 *
 * TODO:
 *
 ***************************************************************************/

/******************************************************************************
 **    INCLUDES
 ******************************************************************************/
#ifndef __DOG_SHARED_LIBRARY_H__
#define __DOG_SHARED_LIBRARY_H__

#include "dog_types.h"
/******************************************************************************
 **    MACROS
 ******************************************************************************/

#define INVALID_LIB_HANDLE nullptr
/******************************************************************************
 **    TYPE DEFINITIONS
 ******************************************************************************/
namespace dog
{

using SharedLibHandle = void*;
/******************************************************************************
 **    CLASSES/FUNCTIONS DEFINITIONS
 ******************************************************************************/
/**
 * @brief load and open a shared library
 * @param in libPath the name of shared library
 * @return successfully: lib handle, failed: INVALID_LIB_HANDLE
 */
DOG_API SharedLibHandle SharedLibOpen(ConstString& libPath);

/**
 *@brief close a loaded shared library
 *@param in slHdl the lib handle
 *@return none. 
 */
DOG_API void  SharedLibClose(SharedLibHandle slHdl);

/**
 *@brief get a symbole(e.g function, variable) from shared library. 
 *@param in slHdl the lib handle
 *@param in sym the name of symbol
 *@return successfully: a pointer point to the symbol, failed: nullptr 
 */
DOG_API void* SharedLibSym(SharedLibHandle slHdl, ConstString& sym);

/**
 *@brief get the last error for above interface called.
 *@param none
 *@return the description string of error
 */
DOG_API std::string SharedLibError();

} /** namespace dog */

#endif /** !__DOG_SHARED_LIBRARY_H__ */

